Learning Objectives

After completing this lesson, you’ll be able to:

Resources

Introduction

You have successfully published a workspace to FME Flow that creates a 3D visualization of recent earthquakes around the world in KML format, using data from the United States Geological Survey. Now you are getting requests from other users who do not have FME Flow accounts but want to be able to run the workspace on demand.

Let's create an FME Flow App so that anyone with the URL can run this workspace to get an up-to-date KML whenever they wish.

1) Navigate to FME Flow

Go to the FME Flow interface and log in.

If you are taking a Safe Software-hosted training course, you can access FME Flow at http://localhost/.

2) Open Flow Apps

Expand Flow Apps from the side menu, then click Create Workspace App, to create a new Workspace App.

Build Workspace App menu option

3) Configure Flow App

Set a Name, Title, and Description for your new Flow App. The Name is what is displayed in the list of Workspace Apps and the Title and Description is what will be displayed on the actual App. 

For this exercise, we will use the following:

Name: earthquake-extrusion

Title: Recent Earthquake Visualization

Description: Visualizes recent earthquakes worldwide.

Select the Samples Repository and the earthquakesextrusion.fmw workspace. Select ‘Data Streaming’ as the Service.  This will allow the information to be streamed back to the user directly within the browser (if supported).

Note

If for some reason your FME Flow is missing this default included workspace, you can download it here and then publish it.

You can leave the expiration time at its default value, which will allow the API Token to expire after 10 years. You could set this to a shorter time if you only want to grant access for a smaller time window.

Keep the Require Authentication toggle disabled. This setting will allow anyone with the URL to run the workspace.

Keep the Users Can Upload toggle enabled. This setting will allow users to upload their own GeoJSON input file instead of using the USGS data.

Create Workspace App filled out

4) Check the Parameters Section

There are two collapsed sections below the first: Parameters and Customize. Click the Parameters section to expand it. You will see the workspace's user parameters, similar to how they appear on the Run Workspace page on FME Flow. You can see the source dataset is set to a URL (http://earthquake.usgs.gov/earthquakes/feed/v1.0/summary/2.5_week.geojson), pulling the recent earthquake data directly from the USGS web service.

Expanded Parameters section

By default, Show in App is selected for the parameter, and you can leave this as it is so app users can have the option of uploading their own GeoJSON file or using the USGS API as the default value. 

Click OK to create the App. 

5) Test the FME Flow App

Now that your App has been created, you'll see that a URL was generated for it.

Workspace App created page

Click on the URL to open the app. You will see that it opens a webpage very similar to the Run Workspace page in FME Flow, but it has no options other than to run this one workspace and it does not require a user to enter a username and password to access it.

Recent Earthquake Visualization Server App

While this looks great, your Flow App is intended to be public-facing so you want to have your brand reflected on the page. Flow Apps can be customized to your own brand with logos, images, and colour. 

6) Edit Flow App

To edit the workspace app, click the Flow Apps section in the FME Flow menu, and then click Manage Workspace Apps.

Click on earthquakes-extrusion to edit it.

7) Customize Flow App

Flow Apps can be customized in a number of ways. You already set the title and description of your app, so we will focus on visuals in this step and add a heading image (1 MB file size limit). 

From the editing page, expand the Customize section. Download Seismograph.jpg and set it as the Heading Banner. You can also edit any of the other customization parameters if you wish.

Scroll down and click OK to finish editing the Flow App.

8) View Customized Flow App

Again, click the link to view your app.

Now your app should have the Seismograph image at the top instead of the FME Flow logo, as well as any other customized elements. 

Click Run to run the earthquakesextrusion.fmw workspace via the App.

Note

If the workspace failed, you should ensure that the source data is available. Check the FME Flow logs for more clues. If for some reason the USGS source data is not available, you can use this example.geojson file instead.

Now you've created a Flow App that can be shared with non-FME Flow users to be able to use FME functionality and access your data. You've also begun customizing Flow Apps with images, logos, and colours.